Add option to use high-visibility icons #293

n-oden · 2022-12-15T16:45:02Z

The default icons used in the pkgname output formats (∅,✓,𐄂) can be hard to spot when scrolling through test output.

This PR adds the ability to pick a higher-visiblity/contrast set of icons (🔳,✅,❌) by adding a -hivis suffix to either of the 'pkgname' style formats.

The default icons used in the pkgname output formats (∅,✔,𐄂) can be hard to spot when scrolling through test output. This PR adds the ability to pick a higher-visiblity/contrast set of icons (🔳,✅,❌) by adding a `-hivis` suffix to either of the 'pkgname' style formats.

dnephin

Thank you for the PR! This is great, we should definitely get this merged!

What operation system are you using? I'm wondering how well these characters will work on MacOS, Windows, and Linux, and if anyone would have to install a new font to get it to work. I can test it on Linux.

If these characters are well supported, I'd like to switch to them by default. Once this merges I'll create an issue and pin it, to have other people test it out before we make it the default.

There are two things I'd like to think about a bit before we merge:

is hivis the right term for this? These characters seem to render very differently. Is it because they are part of some unicode character range, or they have some specific property? I don't know much about unicode.
should this be enabled with a separate flag --format-hivis, or should it be a variant on the format name. I'm thinking since it applies to at least 2 formats (maybe more if we can use this with dots and dots-v2 as well), maybe it should be --format-hivis to enable it.

n-oden · 2022-12-19T17:04:55Z

I personally am testing this on MacOS, but the characters are standard unicode/utf-8 codepoints:

🔳 = U+1F533 "white square button"
✅ = U+2705 "white heavy check mark"
❌ = U+274C "cross mark"

How those particular codepoints render is platform-dependent, but you can see from the emojipedia links above that they are generally similar on most popular platforms. All three codepoints were adopted as part of Unicode 6.0 in 2010 so at this point you'd have to be running a notably old system for them not to render.

To your specific questions:

I'm not overly attached to the name. "Hivis" is a common abbreviation for "high-visibility" and my goal here was to make test failures stand out more clearly in the pkgname output formats. As noted above these are at this point pretty bog-standard unicode characters and should be well supported by any terminal program built in the last 10 years without requiring custom fonts or special configuration.
The way I implemented this, you could add the -hivis suffix to any of the existing format types, it's just that it's a no-op for any formatter that doesn't use shortFormatPackageEvent(). This seemed like the least-inconvenient way to handle it since it meant that the switch statement in NewEventFormatter() didn't need to change, but if you'd prefer to do it as a separate flag that's certainly doable.

n-oden · 2023-01-03T15:32:52Z

Happy new year! @dnephin any thoughts on how you'd like to proceed with this?

Instead of a separate format name.

The other two hivis characters are in the dingbat unicode block, using a code from this block from the third is nice because it increases the chances that a font supports all 3 characters. This character is also a bit less bright, which seems nice for skipped tests, because the focus should be more on the failures.

dnephin · 2023-01-08T20:19:27Z

I tried this out on my desktop and it looks great! The characters render correctly in all the fonts I use on Linux.

I made a few small changes here: odenio/gotestsum@main...dnephin:gotestsum:hivis-icons

use --format-hivis to enable these characters, instead of separate formats. This should make it easier to change to the new characters as the default in the future
removes the constants and moved the definitions inline, because we only ever reference these characters from one function
I tried out a different character for "empty package". The "heavy minus" character is in the same unicode code block as the other two characters ("dingbats"), and is slightly less bright, which I'm hoping helps de-emphasize those packages

Normally I would push those changes to this PR branch, but I do not have permission to do that in this case (maybe you unchecked that box when opening the PR?).

How do you feel about those changes? If they work for you, could you cherry-pick those 2 commits into this branch? Alternatively I can open a PR against your branch, and you can merge that PR to include them here.

With those changes I think this PR is ready to merge. I can create an issue to bring attention to the new --format-hivis flag, and try to get feedback from other users about making those characters the default.

Hivis icons

n-oden · 2023-01-09T15:59:17Z

@dnephin I merged your commits back up into our main branch, so they're part of this PR now. 👍 on all your changes!

dnephin

LGTM, Thank you!

n-oden force-pushed the main branch from 6cd93e9 to a923785 Compare December 15, 2022 16:45

n-oden force-pushed the main branch from a923785 to 493ebf2 Compare December 15, 2022 16:54

dnephin reviewed Dec 17, 2022

View reviewed changes

dnephin added 2 commits January 8, 2023 14:57

Use format option flag for hivis

179c087

Instead of a separate format name.

dnephin mentioned this pull request Jan 8, 2023

Issue new version release #294

Closed

Merge pull request #1 from dnephin/hivis-icons

633d128

Hivis icons

n-oden requested a review from dnephin January 9, 2023 16:41

dnephin approved these changes Jan 14, 2023

View reviewed changes

dnephin merged commit 4b0ada1 into gotestyourself:main Jan 14, 2023

dnephin mentioned this pull request Feb 8, 2023

Format option proposal: pkgname-coverage-graph #302

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add option to use high-visibility icons #293

Add option to use high-visibility icons #293

n-oden commented Dec 15, 2022

dnephin left a comment

n-oden commented Dec 19, 2022

n-oden commented Jan 3, 2023

dnephin commented Jan 8, 2023 •

edited

Loading

n-oden commented Jan 9, 2023

dnephin left a comment

Add option to use high-visibility icons #293

Add option to use high-visibility icons #293

Conversation

n-oden commented Dec 15, 2022

dnephin left a comment

Choose a reason for hiding this comment

n-oden commented Dec 19, 2022

n-oden commented Jan 3, 2023

dnephin commented Jan 8, 2023 • edited Loading

n-oden commented Jan 9, 2023

dnephin left a comment

Choose a reason for hiding this comment

dnephin commented Jan 8, 2023 •

edited

Loading